home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 December / EnigmA AMIGA RUN 13 (1996)(G.R. Edizioni)(IT)[!][issue 1996-12][PLANET CD III].iso / enigma / earcd / unix / uae-0_64.rdm < prev   
Text File  |  1996-11-25  |  32KB  |  686 lines
  1. Short:    V0.6.4 of the Unix Amiga Emulator (now correct !)
  2. Author:   crux@pool.informatik.rwth-aachen.de <Bernd Schmidt>
  3. Uploader: supp@ira.uka.de <Mathias Supp>
  4. Type:     misc/unix
  5.  
  6. This is version 0.6.4 of UAE, the Un*x Amiga Emulator.
  7.  
  8. #include <drivel.h>
  9.  
  10. Copyright 1995, 1996 Bernd Schmidt & contributors (see below). This program is
  11. freeware. You may do whatever you want with it for personal use.
  12. Permission is granted to redistribute this program free of charge, provided it 
  13. is distributed in the full archive with unmodified contents and no profit 
  14. beyond the price of the media on which it is distributed is made. Exception to
  15. the last rule: It may be included on freeware/shareware collections on CD-ROM.
  16. There are no warranties of any kind for this program. If you use this program,
  17. you do so at your own risk. The authors are not responsible for any damages 
  18. that might result from using this program.
  19.  
  20.  
  21. Overview
  22. ========
  23.  
  24. UAE emulates the hardware of an A500 with 2MB chip and a variable amount of
  25. fast memory. Up to 11.8MB RAM are supported. It works with all Kickstart ROM
  26. versions, provided they are not compiled for the 68020. It supports some (one,
  27. to be precise) ECS features apart from nearly all the functionality of an OCS
  28. chipset.
  29.  
  30. UAE was developed for Unixoid systems. Meanwhile, it has been ported to the
  31. Mac, DOS, the BeBox, NextStep, the XFree86/OS2 environment and AA Amigas (it 
  32. can't quite run itself yet). The Mac and DOS versions are distributed with 
  33. binaries and a seperate README file that you should read after you have 
  34. finished this document. The other versions must be compiled from the source 
  35. code.
  36.  
  37. What UAE does not (yet) emulate is software. To use UAE, you need a Kickstart 
  38. ROM image as well as any other software you want to run, e.g. a Workbench 
  39. disk. Both are copyrighted, and I can't include them. Don't ask me to send 
  40. them to you.
  41. Since the PC floppy controller can't read Amiga disks (yes, that's a fact), 
  42. floppy access has to be emulated differently: Floppies are emulated by means 
  43. of disk files that contain a raw image of the floppy disk you want to emulate.
  44. Read the section "tools" below for information how to create ROM images and 
  45. disk files.
  46. You can also emulate a harddisk. UAE can mount native filesystems as
  47. harddrives, so once you have booted it up, you can access all your files on
  48. the harddisk. It is currently impossible to boot from the emulated harddisk.
  49. I don't have a clue why.
  50.  
  51. I am developing UAE using Linux. Only if you are running Linux can you be 
  52. reasonably sure that all versions of UAE will work for you. On other Unix 
  53. systems, you may encounter problems from time to time. I can make no 
  54. guarantees about the NextStep and BeBox versions, these are very recent ports
  55. and will probably need some more time before they compile/run reliably.
  56.  
  57. These are the requirements for getting the Unix version to run:
  58.   - X11, or SVGAlib if you are using Linux.
  59.   - an ANSI C compiler. GCC is _strongly_ recommended.
  60.   - Optionally, tcl7.4/tk4.0
  61.  
  62. Note: some Linux installations (usually Slackware) are broken. If you get
  63. linker errors ("final link failed: bad value"), you need to upgrade the 
  64. binutils package that you can find on sunsite.unc.edu:/pub/Linux/GCC
  65. Before installing anything from that directory, read the corresponding
  66. release.* files.
  67. You'll get better performance if you are using an ELF system.
  68.  
  69. On Linux, 8MB are sufficient to run UAE, although startup will be much faster
  70. if you have some additional memory. The DOS version also works with 8MB, but 
  71. startup is slow there too. I have not tried the other ports, it may well be 
  72. that other OS's are better at wasting memory. At least 16MB are recommended.
  73.  
  74. This section is just what it says: an overview. Please read _all_ of this
  75. file, especially if you have problems. Please read also the file "FAQ" which
  76. contains some Frequently Asked Questions (and even the answers!)
  77.  
  78.  
  79. Installation
  80. ============
  81.  
  82. To build UAE, first unpack it to an appropriate directory (e.g. /usr/src/uae
  83. on a Linux system). After that, you will have to edit the file config.h to set
  84. some configuration options. Then, you should give the command "configure". 
  85. This script will determine what type of system you are using. It will then
  86. create an appropriate Makefile. Type "make" after that to build UAE.
  87.  
  88. If you are running Linux, you can say "configure --without-x" as an 
  89. alternative. If you do this, UAE will be configured to use the SVGA library.
  90. If you use SVGAlib, be warned that SVGAlib is not too stable and using it is 
  91. inherently a little dangerous, you might want to have a way to log in from a 
  92. remote terminal if things go horribly wrong. If you are very unfortunate, you 
  93. might lock up your machine otherwise.
  94. Note that you must be root to run SVGAlib programs. Making UAE suid root is
  95. _not_ a particularly good idea if you care about the security of your system.
  96. If you have a BeBox, you should not run configure. Instead, compile UAE by
  97. doing "make bebox".
  98.  
  99. If you configure UAE for building the X11 version (which is the default if you
  100. simply say "configure"), the configure script will try to find the program
  101. "wish4.0" in the path. You can disable the UAE user-interface by passing the
  102. "--disable-gui" option to configure. By default, the X11 version of UAE
  103. tries to use a GUI written in Tcl. This requires Tk version 4.0. The SVGAlib
  104. version uses a ncurses-based user interface.
  105.  
  106. The compilation may take a while, especially for the cpu*.c files. There might
  107. be some warnings, ignore these. It may also take a lot of memory. You should 
  108. have at least 8MB physical RAM to compile this, plus maybe 10MB swap and 9MB
  109. filesystem space.
  110.  
  111. After compilation, you'll need to install the ROM image. This must have a size
  112. of exactly 512K (if you only have a 256K image of a 1.x Kickstart, that should 
  113. work, too) and should be an image of the addresses 0xF80000-0xFFFFFF on
  114. your Amiga system. The file must be called kick.rom to be recognized. Please
  115. read the next section on how to transfer files from your Amiga to your PC.
  116.  
  117. You also need to install a disk image file. This must be called df0.adf (adf =
  118. Amiga Disk File), and should be a raw image of the data on the floppy disk: 
  119. 11x2x80 sectors == 901120 bytes.
  120. Please try running UAE without a diskfile first. If everything went O.K., the
  121. emulator should show the Kickstart logo (don't be too impatient, this will
  122. take a while on slow machines).
  123.  
  124. If you don't have a Kickstart file, you may still be able to boot some games
  125. and demos. The emulator includes some primitive bootstrap code that will try
  126. to read and execute the bootblock of the diskfile you are using, and if that
  127. bootblock only uses the one or two Kickstart functions that are supported by 
  128. the "replacement Kickstart", your program will boot. Don't expect too much, 
  129. though.
  130.  
  131. If you are a daring person, you can edit custom.c before compiling and enable
  132. the "EMULATE_AGA" define. UAE will then try to emulate some AGA features. I'd
  133. like to hear feedback as to how well it works (expect it not to work at all
  134. for a start).
  135.  
  136.  
  137. Invoking UAE
  138. ============
  139.  
  140. After building the program, you should have an executable called "uae". You
  141. can simply execute it, but you can also optionally give it one of the following
  142. parameters:
  143.  
  144. General options:
  145.  -h      : Give help on the options.
  146.  -f n    : Sets the frame rate to 1/n. Only every nth screen will be drawn.
  147.  -a      : Add no expansion devices. This will disable fastmem and harddisk
  148.            emulation, but some extremely badly-written games may need this.
  149.  -l lang : Set the keyboard language. Currently, the following values can be 
  150.        used for lang: "us" for U.S. keyboard (default), "se" for swedish, 
  151.        "fr" for french, "it" for italian  or "de" for german keyboard.
  152.  -0 file : Try to use file as diskfile for drive 0 instead of df0.adf.
  153.            -1 file, -2 file and -3 also exist for the other drives.
  154.  -r file : Use file instead of kick.rom as Kickstart image.
  155.  -J      : Use the numeric pad for joystick emulation (with 5 and 0 as fire 
  156.            buttons). This will turn off real joystick support. It's no good 
  157.        for action games, but may be useful for other games.
  158.  -x      : General-purpose option. For the X version, it makes the X cursor 
  159.            visible (recommended). For the SVGAlib version, it turns off
  160.        linear framebuffer support (sometimes, with -d 4, SVGAlib is
  161.        faster without linear framebuffer).
  162.  -o      : Allow UAE to overwrite ~/.uaerc with the selected options. This is
  163.            only used by the text-based GUI in the SVGAlib and DOS versions.
  164.  -G      : Disable the user interface (if present).
  165.  
  166. Emulating external devices (harddisk, printer, serial port):
  167.  -M VOLUME:path
  168.  -m VOLUME:path
  169.            mount the unix file system at path as an Amiga filesystem with
  170.        volume name "VOLUME:". For example, "-M sound:/usr/amiga/modules"
  171.        If you use -M instead of -m, the volume will be read only.
  172.        See below.
  173.  -p cmd  : Enable printing. See below.
  174.  -I dev  : Use "dev" as serial device (e.g. /dev/ttyS1 on Linux). Doesn't
  175.            really work yet, at least not for me.
  176.  
  177. Sound options:
  178.  -S n    : If your version of UAE supports sound, set the sound support level
  179.            with this option.
  180.        n = 0: No proper sound emulation at all. May be incompatible 
  181.               (unlikely). This is the default.
  182.        n = 1: Emulate the sound hardware, but don't output sound. May be
  183.               needed for compatibility, but can be much slower
  184.        n = 2: Emulate the sound hardware and output sound. Recommended.
  185.        n = 3: Emulate the sound hardware _exactly_. I don't think you'll
  186.               hear a difference. SIDmon modules will be emulated 
  187.           correctly, but painfully slow with this setting.
  188.  -b n    : Use n bits for sound output (8 or 16)
  189.  -R n    : Use n Hz to output sound. Common values are 22050 Hz or 44100 Hz.
  190.  -B n    : Use a sound buffer of n bytes (use small values on fast machines)
  191.            Default is 8192.
  192.        
  193. Memory options:
  194.  -s n    : Emulate n*256K slow memory at 0xC00000. Some demos/games need this.
  195.  -F n    : Emulate n megabytes of fast memory as an expansion board.
  196.  -c n    : Emulate n*512K chip memory. The default is 2MB chipram. Some very
  197.            broken programs need "-c 1" to work properly.
  198.        
  199. Debugging options:
  200.  -D      : Don't start the emulator at once, use the built-in debugger.
  201.  -i      : Print illegal memory accesses
  202.  -g      : Emulate parts of the OS. This isn't very stable and not
  203.            recommended.
  204.  
  205. Display options:
  206.  -d mode : Select a graphical resolution for UAE to run in.
  207.  -H mode : Select a color mode to use.
  208.  -C      : Correct the aspect. Normally, graphics will be only half as high
  209.            as they should be, this option draws every line twice to correct
  210.        this. It makes the emulation slower, though.
  211.        Proper emulation of interlace mode is impossible without this
  212.        option.
  213.  
  214. Resolutions: 0 (320x200); 1 (320x240); 2 (320x400); 3 (640x480);
  215.              4 (800x600).
  216. Color modes: 0 (256 colors, default); 1 (32768 colors); 2 (65536 colors)
  217.              3 (256 colors, with dithering to improve color quality)
  218.          4 (16 colors, dithered); 5 (16 million colors)
  219.  
  220. UAE may choose to ignore and/or refuse some combinations of these two
  221. parameters. Some of these modes may also fail to work on your system.
  222.  
  223. You can also put these options into a configuration file in your home
  224. directory. Simply create ~/.uaerc and put some of these options in it. On
  225. non-Unix systems, the file is called uae.rc and should be located in the
  226. current directory.
  227.  
  228. If you use SVGAlib, the only way to leave the program is pressing F12.
  229.  
  230.  
  231. Choosing color and screen modes
  232. ===============================
  233.  
  234. As described in the previous paragraph, UAE can run in many different 
  235. resolutions and color modes. However, few of the color mode options are
  236. available if you use the X11 version of UAE, since the X server determines
  237. how many colors are available. If you are running a 256 color X server, you
  238. can use "-H3" to tell UAE to dither the colors for better results.
  239.  
  240. You will have to experiment which mode gives the best results for you at a
  241. satisfying speed. Note that the dithering process consumes time, so even if
  242. 256 colors with dithering look better than 256 colors without, remember that
  243. UAE will be slower in that mode.
  244.  
  245. The low-resolution (320x???) modes should help some of the proud owners of new
  246. P6 systems with a broken chipset and an exciting PCI performance of 4MB/s :-)
  247.  
  248. The recommended resolution is 800x600. In the lower resolution modes, some
  249. overscan pictures the Amiga tries to display may not fit entirely on the
  250. screen, others may be off-center and some graphical effects may look weird.
  251. For best results, use 800x600 with at least 32768 colors.
  252.  
  253.  
  254. Harddisk emulation
  255. ==================
  256.  
  257. !! Careful: All of this has been rewritten for this version. There may be
  258. bugs, please report any strange events.
  259.  
  260. Using diskfiles is awkward. There are two ways how you can use larger amounts 
  261. of data with UAE. UAE can emulate more than one harddisk at one time, the
  262. volumes will be named UAE0:, UAE1:, etc. UAE will boot from UAE0: if no
  263. diskfile is found for floppy drive 0.
  264.  
  265. a) Harddisk files.
  266. You can create a (unformatted) harddisk file with
  267.  
  268.   dd if=/dev/zero of=hardfile bs=512 count=16384
  269.   
  270. Currently, the size is fixed (8MB).
  271.  
  272. The harddisk file is accessed by a resident ROM module that is built into the
  273. emulator, called "hardfile.device". If it is present, this is always the first
  274. harddisk device the emulator finds and will be named UAE0:
  275.  
  276. If you are using Kickstart 1.3 or earlier, this can't currently be mounted at 
  277. boot time, and therefore you can't boot from it either. You will have to boot
  278. either from a floppy disk image or from a filesystem (see below), and mount
  279. the hardfile.device later. To do this, add the following to "DEVS:mountlist":
  280.  
  281. UAE0:       Device = hardfile.device
  282.        Unit   = 0
  283.        Flags  = 0
  284.        Surfaces  = 1
  285.        BlocksPerTrack = 32
  286.        Reserved = 1
  287.        Interleave = 0
  288.        LowCyl = 0  ;  HighCyl = 511
  289.        Buffers = 5
  290.        DosType = 0x444F5300
  291.        BufMemType = 1
  292. #
  293.  
  294. Then, type "mount UAE0:" (or put that command in your startup-sequence), and
  295. you should be able to access it. Don't forget to format it with the AmigaDOS
  296. format command:
  297.  
  298.   format drive uae0: name Mister_Willwink
  299.  
  300. b) Access native filesystems from the emulator.
  301.  
  302. This has some major advantages:
  303.  - It has no problems with Kickstart 1.3
  304.  - It is more convenient.
  305.  - It is much faster. In fact, it can be dramatically faster even than a real
  306.    Amiga when reading directories.
  307.  
  308. However, it currently does not work on some ports.
  309.  
  310. If you specify the -M or -m command line arguments, you can use files on your
  311. Unix filesystem from the emulator. If you start UAE with
  312.  
  313.   uae -m sound:/usr/amiga/modules
  314.   
  315. you can access all the files in /usr/amiga/modules by reading from the
  316. AmigaDOS volume "SOUND:".
  317. (DOS users: try "uae -m dh0:C:\" to mount your drive C:\ as DH0:)
  318.  
  319. If you want to execute files, they need to have the x permission bit set.
  320. That can be done in Unix by "chmod +x file" or in AmigaDOS with 
  321. "protect file rwed".
  322. You can mount up to 20 devices by giving this option multiple times.
  323.  
  324.  
  325. Tools / Transferring files
  326. ==========================
  327.  
  328. To transfer any software between an Amiga and another computer, you'll need
  329. either a tool like CrossDOS or MessyFS on the Amiga that lets you read and
  330. write PC formatted disks, or a serial null-modem cable. CrossDOS is part of
  331. the newer Amiga operating systems; MessyFS is free software and can probably
  332. be found on some old Fish disk. To transfer data over a null-modem cable it is
  333. useful to use some sort of terminal software on both ends. I can't explain
  334. here in every detail how to use terminal programs or CrossDOS. Please read the
  335. appropriate documentation. Note: If you use a tool to read/write PC-formatted
  336. disks on the Amiga, remember that most Amiga drives handle only DD disks, so
  337. don't try to use HD floppies.
  338.  
  339. In the "amiga" subdirectory you'll find two small Amiga programs that you can
  340. use to transfer software from the Amiga to the PC. These are called transrom 
  341. and transdisk. Copy them to your Amiga and make them executable (by typing
  342. "protect transrom rwed" and "protect transdisk rwed" in the Amiga shell 
  343. window).
  344. transrom will dump the contents of your Kickstart ROM, and transdisk will 
  345. dump an image of a floppy in one of the drives. Both programs write to the
  346. standard output, so you'll want to redirect that. Do
  347.  
  348.    transrom >ram:kick.rom
  349.    
  350. to create a file called "kick.rom" in the RAM disk, and
  351.  
  352.    transdisk >ram:df0.adf
  353.    
  354. to create a file called "df0.adf" in the RAM disk. These files are pretty
  355. big, 524288 bytes for the ROM image and 901120 bytes for a disk image.
  356. transdisk understands the following arguments:
  357.  
  358.     -d device unit: Use this device instead of DF0:
  359.     -s n: Begin transfer at track n (default: 0)
  360.     -e n: End transfer at track n (default: 79)
  361.  
  362. So, to transfer the disk in drive DF1:, you'd give the command:
  363.  
  364.   transdisk >ram:df1.adf -d trackdisk 1
  365.  
  366. If you don't have much RAM and can't fit all of a disk image in the RAM disk,
  367. you can split up the transfer into multiple parts with the "-s" and "-e"
  368. parameters. To transfer the disk in four parts, you'd use the following 
  369. commands:
  370.   
  371.   transdisk >ram:df0_1.adf -s 0 -e 19
  372.   transdisk >ram:df0_2.adf -s 20 -e 39
  373.   transdisk >ram:df0_3.adf -s 40 -e 59
  374.   transdisk >ram:df0_4.adf -s 60 -e 79
  375.  
  376. Of course, you should save each of the four files to another place before
  377. transferring the next one with transdisk to make space in your RAM disk. 
  378. If you have all the files on your PC, you can do the following under Unix:
  379.   cat df0_1.adf df0_2.adf df0_3.adf df0_4.adf >df0.adf
  380. or, under DOS:
  381.   COPY /B df0_1.adf df0_2.adf df0_3.adf df0_4.adf df0.adf
  382. I've been told there are the following tools for the Mac to join binaries:
  383. "ChunkJoiner 2.1.2" found under Info-Mac's <disk> directory or 
  384. "JoinFiles 1.0.1" under Info-Mac's <text>.
  385.  
  386. The current transdisk can only read the standard AmigaDOS format. This means
  387. that most games that rely on some form of copy-protection cannot be
  388. transferred. However, there are disks that are formatted in the normal 880K
  389. format that transdisk can read, but don't have a filesystem ("NDOS" disks
  390. in the Workbench). These will be transferred correctly.
  391.  
  392. There's an easy way to use a null-modem cable without terminal software if
  393. you use Linux. You can do
  394.  
  395.   transdisk >SER: <options>
  396.   
  397. on the Amiga to copy the data directly to the serial port. Before that, do
  398.  
  399.   cat /dev/ttyS1 >df0.adf
  400.   
  401. on your Linux box to receive the data (it may be ttyS0 on your system, or
  402. another number, depending on which serial port you are using). When the Amiga
  403. is done transferring, hit ^C on the PC to interrupt the cat program. To make
  404. this work, you need to use the same settings for the serial port on both
  405. sides. This is done with the Preferences program on the Amiga (this is split
  406. into several programs from Kickstart 2.0 upwards, you'll find a program called
  407. "serial" in the Prefs directory of your Workbench disk). On the Linux side,
  408. use the stty program. "man stty" will give you the manpage describing how to
  409. use it.
  410. To be on the safe side, set the speed to a low value (2400 baud). Turn off
  411. Xon/Xoff, but enable RTS/CTS.
  412. I use the following command myself:
  413.  
  414.   stty 19200 parenb -cstopb cread clocal crtscts -istrip -inlcr -icrnl -opost
  415.     -onlcr -parodd -isig -icanon -iexten raw cs8 </dev/ttyS1
  416.  
  417. which is probably overkill, but you never know :)
  418. This maps to 19200 baud, 8 bits, even parity, one stop bit, which you have to
  419. set in the Amiga preferences.
  420.  
  421. If you transfer commercial software, you must not distribute the resulting
  422. image files, since that would be a violation of copyright law. The Kickstart
  423. ROM has to be considered commercial software. You may only use the Kickstart
  424. from your own Amiga, and you may not distribute Kickstart ROM files.
  425. Please read the license that came with your software for details.
  426.  
  427. If you have a disk image file, and you want to retrieve the files from it, you
  428. can use the "readdisk" tool. It is automatically built by "make". If you have
  429. a disk image of a disk called "Workbench1.3D" as df0.adf, and you do
  430.    readdisk df0.adf
  431. the whole directory structure of the disk image will be stored in a newly
  432. created subdirectory called "Workbench1.3D". You can optionally give a second
  433. parameter to specify a directory where to create the output other than the
  434. current directory.
  435. readdisk only understands about the OFS right now. FFS disks will cheerfully
  436. be regarded as being unreadable. Use the unixfs.device from within the
  437. emulator if you want to transfer files from FFS disks. If you use Linux with
  438. a kernel version >= 2.0.7 and version 2.5k of the mount program, you can do
  439.    mount df0.adf /mnt -t affs -o loop
  440. You'll need to enable support for the Amiga filesystem and the loop device
  441. when configuring and compiling the kernel.
  442.  
  443.   
  444.  
  445. The UAE_CONTROL program
  446. =======================
  447.  
  448. In the "amiga" subdirectory, you will find two programs, uae_control and
  449. uaectrl that provide the same functionality as the X11 GUI. uaectrl is
  450. shell-based and works with any Kickstart, while uae_control needs the
  451. gadtools.library and a recent version of reqtools.library, so it only works
  452. with Kick 2.0 and upwards. Copy these two programs to the directory that you
  453. use for harddisk emulation. They should be self-explanatory.
  454.  
  455.  
  456. Printing
  457. ========
  458.  
  459. With the "-p cmd" option, you can specify a command that will be run when the
  460. emulator detects that the Amiga accesses the parallel port. Usually, you will
  461. want to say "-p lpr" to pass the output over to lpd. It's unclear how this
  462. will work on non-Unix systems, DOS users can try "-p LPT1:" or something like
  463. this.
  464. For best results, select the PostScript driver in the Amiga Preferences. This
  465. is only available in newer Kickstarts. Printing is not going to work with
  466. another printer driver.
  467. None of this is guaranteed to work yet, and I have not tried any of this yet.
  468.  
  469.  
  470. Quick overview of the debugger commands
  471. =======================================
  472.  
  473. If you use the X11 version, you can press ^C at any time to enter the built-in
  474. MC68000 debugger.
  475. Each debugger command consists of a single letter and occasionally some
  476. parameters.
  477.  
  478. g:                    Start execution at the current address. 
  479. c:                    Dump state of the CIA and custom chips.
  480. r:                    Dump state of the CPU
  481. m <address> <lines>:  Memory dump starting at <address>
  482. d <address> <lines>:  Disassembly starting at <address>
  483. t:                    Step one instruction
  484. z:                    Step through one instruction - useful for JSR, DBRA etc.
  485. f <address>:          Step forward until PC == <address>
  486. q:                    Quit the emulator. You don't want to use this command.
  487.  
  488. (^C has no effect if UAE is compiled for SVGAlib - use F12 to exit)
  489.  
  490.  
  491. Input devices
  492. =============
  493.  
  494. Mouse, keyboard and joystick can be used in a straightforward way. A couple of
  495. keyboard languages are supported with the "-l" commandline option. If you have
  496. a different keyboard, patches to make UAE work with it are appreciated.
  497. The X version of the emulator will try to keep the Amiga mouse pointer at the
  498. same location as the X mouse pointer. You can turn off this mode if it does
  499. not work with your program by pressing F12. This is needed (for example) for
  500. Lemmings and the Magnetic Scrolls adventures, which don't use sprite 0 as a
  501. mouse pointer. Other versions (SVGAlib, DOS, possibly others) do not have this 
  502. problem.
  503. If you use Linux and have the joystick driver kernel module, "configure"
  504. should automatically enable support for it. UAE calibrates the joystick
  505. automatically. Turn it a few times on startup to get the calibration done. 
  506.  
  507.  
  508. Sound
  509. =====
  510.  
  511. If you define LINUX_SOUND in config.h, the emulator will use /dev/dsp to 
  512. output sound. You can pass parameters like frequency or number of bits to use
  513. on the commandline; if you don't specify any, sane defaults will be used. If
  514. graphics output is enabled while sound is output, the emulator will be much 
  515. too slow on most systems. The sound will not be continuous. Therefore, a hack
  516. to turn off screen updates is provided: Press ScrollLock to disable graphics,
  517. press it again to enable them (note: for X, you'll have to press it twice each
  518. time).
  519. The LINUX_SOUND_SLOW_MACHINE option will steal cycles from the CPU emulator.
  520. The relative CPU speed will be reduced somewhat if this option is set. This may
  521. lead to incompatibilities.
  522.  
  523. The quality of the emulation depends on the setting of the "-S" commandline
  524. option. With "-S 3", all of the sound hardware is emulated; and some programs
  525. (e.g. AIBB) won't run with other settings. "-S 2" should sound just as good as
  526. "-S 3" and will be much faster for some programs. "-S 1" tries to emulate most
  527. of the sound hardware, but doesn't actually output sound. "-S 0" completely
  528. turns off sound.
  529.  
  530. On other Unix systems, the AF sound system may be available. You can configure
  531. UAE to use this, too, by changing some paths in the Makefile (I can't answer
  532. any questions about this, I never saw/used it).
  533.  
  534.  
  535. Speed
  536. =====
  537.  
  538. The Most Frequently Asked Question is: "Just how fast is it?", and this is
  539. also the most difficult one to answer. The easy way to answer is "It depends",
  540. but I'll try to do better. All timings I give here were measured on my
  541. machine, a P90 (using SVGAlib, with all the x86 assembly options turned on).
  542. The MC68000 emulation is more than twice as fast as a real A500. I measured
  543. this by letting PowerPacker try to compress itself (it already was compressed).
  544. It took UAE about 6 minutes, my A500 took about 15. If you set the frame rate 
  545. to a high value (i.e. leaving out many frames), the graphics speed does not 
  546. matter and you get about twice the speed of an A500. If you enable the smart
  547. update method in config.h, and if it works for your program (it works for 
  548. almost all programs using the Workbench) you also get about the same speed at 
  549. full frame rate.
  550. For games and demos, the CPU speed does not matter, but the average frame time
  551. is important. UAE can calculate this automatically. The SVGAlib version gives
  552. the number when you exit the emulator, to obtain the value with the X version
  553. you need to interrupt it and type "c" in the debugger. A real A500 has a
  554. constant frame time of 20ms (50 Hz).
  555. If you have a game/demo that has lots of blitter activity, many copper/sprite
  556. effects, dual playfields and scrolling, no one can help you. Fortunately, this
  557. case is extremely rare. Normal games that have a number of blitter objects,
  558. scrolling and maybe some sprites run at 1/3-1/4 the speed of an A500 in the 
  559. worst case, some run at 1/2 the speed. Lowering the frame rate helps
  560. enormously here, and at 1/5 frame rate, about everything runs somewhere
  561. between 50% and 100% the speed of an A500.
  562. This still isn't the full story (I bet you start to see why the question is
  563. hard to answer). A real A500 without fast memory gets slowed down to about
  564. half its speed in Hires 16 color mode. More bitplanes also slow UAE down, but
  565. not quite as much, so it can be several times faster than an A500 in that 
  566. mode.
  567.  
  568.  
  569. Bugs / Unimplemented features
  570. =============================
  571.  
  572. The sprite emulation is incomplete and buggy. Sprite collisions are not 
  573. implemented yet. The serial port emulation doesn't seem to be useful yet.
  574. Apart from that, UAE can do everything a real A500 can do (and more), but 
  575. there may still be one or two buglets that make some programs fail.
  576.  
  577.  
  578. Thanks & Acknowledgements
  579. =========================
  580.  
  581. Thanks to all who have written me so far with bugreports and success/failure
  582. reports when trying to run the emulator on various hardware with different
  583. Kickstart versions. A list of everyone who has contributed to the source code
  584. can be found in the CREDITS file (this was getting too big to keep it here).
  585.  
  586. Special thanks to:
  587.   - Jay Miner, Dale Luck, R.J. Mical and all the others who built the Amiga.
  588.   - Felix Bardos, whose HRM I "borrowed".
  589.   - Hetz Ben Hamo mailed Peter Kittel from Commodore asking for permission to
  590.     give Kick 1.3 away. Unfortunately, the response was negative :-(
  591.   - Bruno Coste, Ed Hanway, Alessandro Soldo and Marko Nippula provided 
  592.     documentation
  593.   - Fabio Ciucci gets the "Best bug reports" award for his help with the
  594.     blitter line emulation and other problem areas.
  595.  
  596.  
  597. Ports
  598. =====
  599.  
  600. Apart from the "main" Unix version, several ports of UAE are ready/being
  601. developed.
  602.  
  603. Gustavo Goedert <ggoedert@music.pucrs.br> has ported UAE to DOS using the
  604. DJGPP port of GCC. The binary is available on several ftp sites as well as on
  605. my Web site.
  606.  
  607. Ernesto Corvi <macsupport@overnet.com.ar> has ported UAE to the Apple
  608. Macintosh. He tells me it is available on Info-Mac, and that every Mac user
  609. should know where that is. A link to the archive containing both PPC and 68k
  610. binaries is on my Web page. (info-mac is mirrored by
  611. sunsite.informatik.rwth-aachen.de)
  612.  
  613. Christian Bauer <bauec002@goofy.zdv.uni-mainz.de> has ported UAE to the 
  614. BeBox.
  615.  
  616. Ian Stephenson <ians@cam-ani.co.uk> has ported UAE to NextStep.
  617.  
  618. Olaf 'Olsen' Barthel <olsen@sourcery.han.de> has ported UAE to the Amiga. This
  619. port requires the AA chipset as well as Kickstart 3.0 or higher. CyberGraphX
  620. is supported. Please read the file "amiga.c" for information. To compile it,
  621. you need SAS/C and the 3.0 includes (they probably come with the compiler).
  622.  
  623. Krister Bergman <bellman@kuai.se> has ported UAE to the XFree86/OS2
  624. environment. This port can be obtained from Krister's WWW page:
  625. <http://www.kuai.se/~bellman/html/xfreeapps.html>
  626.  
  627. Since I generally don't have the possibility to test or improve these ports,
  628. it is a good idea to contact their respective authors if you have questions.
  629.  
  630.  
  631. Pointers
  632. ========
  633.  
  634. There are a few sites in the Internet that contain helpful information about
  635. UAE.
  636.  
  637. I have set up a WEB page for UAE. You will find interim versions, Linux
  638. binaries, diskfiles with Amiga software and other interesting stuff there.
  639. The address is
  640.  
  641. http://www-users.informatik.rwth-aachen.de/~crux/uae.html
  642.  
  643. There, you will find links to other UAE pages. I'll add these links to this
  644. document in the next version, but I don't have them here right now.
  645.  
  646. I post announcements of new versions of UAE to the newsgroup 
  647. comp.emulators.misc. From time to time, I also upload new versions to the ftp
  648. server sunsite.unc.edu. You will find them either in pub/Linux/Incoming or in
  649. pub/Linux/system/Emulators. There are many sunsite mirrors throughout the
  650. world, you should be able to find one near you.
  651.  
  652.  
  653. The author's address
  654. ====================
  655.  
  656. Before you contact me with a problem that you have, make sure you have read
  657. _all_ of the above. Please read also the file "FAQ", which conains a lot of
  658. helpful information. In the future, I will probably no longer respond to
  659. questions that are already answered by any of these files.
  660.  
  661. crux@pool.informatik.rwth-aachen.de
  662.  
  663. or, via snailmail
  664.  
  665. Bernd Schmidt
  666. Schlossweiherstrasse 14
  667. 52072 Aachen
  668. Germany
  669.  
  670. Email is more likely to be answered, and will definitely be answered much
  671. faster. Please avoid phonecalls if you can.
  672. I can't answer _every_ question. If you have trouble understanding this
  673. README, either because you don't speak English very well or because you have
  674. no clue at all about computers, please try to find someone near you who does
  675. understand this file and who can translate/explain it for you. I simply can't
  676. explain (for example) how to use terminal programs or CrossDOS because I don't
  677. use either, and it would be much too time-consuming anyway. This file and the
  678. file FAQ contains about every piece of information I can give you. I try to
  679. help people who have questions, but sometimes it takes too much time.
  680.  
  681. Please don't ask for Kickstart ROM files.
  682.  
  683. Oh, and another thing: If I promise to do things (like implement new
  684. features), and forget about them, pester me. That happens occasionally, it's
  685. a known bug in my brain. I'll have it replaced.
  686.